/*
 *  Copyright 2010-2011, Social Music Discovery project
 *  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are met:
 *      * Redistributions of source code must retain the above copyright
 *        notice, this list of conditions and the following disclaimer.
 *      * Redistributions in binary form must reproduce the above copyright
 *        notice, this list of conditions and the following disclaimer in the
 *        documentation and/or other materials provided with the distribution.
 *      * Neither the name of Social Music Discovery project nor the
 *        names of its contributors may be used to endorse or promote products
 *        derived from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 *  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 *  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 *  DISCLAIMED. IN NO EVENT SHALL SOCIAL MUSIC DISCOVERY PROJECT BE LIABLE FOR ANY
 *  DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 *  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 *  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 *  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 *  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.socialmusicdiscovery.yggdrasil.foundation.dialogs;

import org.eclipse.ui.IEditorInput;
import org.socialmusicdiscovery.yggdrasil.foundation.content.AbstractDependentEntity;
import org.socialmusicdiscovery.yggdrasil.foundation.content.AbstractObservableEntity;


/**
 * An "editor" for creating new child instances to a parent, typically
 * implemented as a modal dialog. This is primarily useful for creating dependent 
 * entities that do not implement {@link IEditorInput} and hence cannot be edited 
 * in a regular editor. 
 * 
 * @author Peer Törngren
 * 
 * @param <P> the parent of the child to be created
 * @param <C> the child that gets created for the parent
 */
public interface FactoryDialog<P extends AbstractObservableEntity, C extends AbstractDependentEntity> {

	/**
	 * Create a new child to supplied parent.
	 * 
	 * @param parent
	 * @return A new child instance, or <code>null</code>. The parent-child
	 *         relation (if any) depends on the implementation.
	 */
	C createChild(P parent);
}
